home *** CD-ROM | disk | FTP | other *** search
/ Suzy B Software 2 / Suzy B Software CD-ROM 2 (1994).iso / prntutil / ideal340 / ideatool / ideaform / ideaform.txt < prev   
Text File  |  1995-04-25  |  8KB  |  163 lines
  1. --------------------------------------------------
  2. A n l e i t u n g   z u   I d e a F o r m    V1.30
  3. --------------------------------------------------
  4.  
  5.  
  6. Umfang
  7. ------
  8. Der Ordner IDEAFORM enthält:
  9.   IDEAFORM.PRG : Programmdatei
  10.   IDEAFORM.RSC : Resourcedatei
  11.   IDEAFORM.TXT : diese Anleitung
  12.   KEY/IDEAFORM.KEY : Default-Schlüsseldatei
  13.       BAS.KEY      : Schlüsseldatei für Basic-Quellen
  14.       C.KEY        : Schlüsseldatei für C-Quellen
  15.       KBJ.KEY      : Schlüsseldatei für Kobold-Jobdateien
  16.       MOD.KEY      : Schlüsseldatei für Modula2-Quellen
  17.       PAS.KEY      : Schlüsseldatei für Pascal-Quellen
  18.       S.KEY        : Schlüsseldatei für Assembler-Quellen
  19.       TEX.KEY      : Schlüsseldatei für LaTeX-Dateien
  20.  
  21. Rechtliches
  22. -----------
  23. Autor: Christoph Bartholme, Ettlinger Stra₧e 37, D-76137 Karlsruhe, Germany
  24.  
  25. Entwickelt mit ST PASCAL+ (CCD) und Assembler
  26.  
  27. IdeaForm ist ein Public-Domain-Utility zu IdeaList (Shareware)
  28.  
  29. IdeaForm darf von jedermann/frau angewendet und weitergegeben werden, jedoch
  30. mu₧  stets  der  gesamte  unveränderte  Inhalt  des Ordners IDEAFORM kopiert
  31. werden.  Kürzungen  und  Änderungen  verletzen  die  Copyright-Bestimmungen!
  32. Sollten Sie nicht alle Dateien erhalten haben, so verständigen Sie bitte den
  33. Autor.
  34.  
  35. Der  Autor  ist  nicht  verantwortlich für irgendwelche Schäden, welche, wie
  36. auch immer, durch Anwendung von IdeaForm entstehen.
  37.  
  38. Die alte TTP-Version (V1.26) ist auf Anfrage erhältlich.
  39.  
  40.  
  41. Sinn und Zweck
  42. --------------
  43. IdeaForm  ist  ein  Hilfsprogramm  für  IdeaList.  Es  dient dazu, Programm-
  44. Listings (oder vielmehr die Quelldateien dazu) zu formatieren. Das hei₧t, es
  45. werden   bestimmte  Wörter  und  Kommentare  durch  spezielle  Steuerzeichen
  46. markiert.  Die  Ausgabedatei  kann  dann  mit  IdeaList  ausgedruckt werden,
  47. wodurch  die  Steuerzeichen  in  die  entsprechenden  Codes  des verwendeten
  48. Druckers  umgewandelt  werden  (z.B.  Fett- oder Kursiv-Druck). Das Programm
  49. wird  über  eine  Schlüsseldatei IDEAFORM.KEY an die Syntax der Programmier-
  50. sprache  angepa₧t.  Natürlich  sind  mit einer entsprechenden Schlüsseldatei
  51. auch  "normale"  Textdateien  verarbeitbar,  z.B.  Tabellen,  Kalender  oder
  52. einfach zur Hervorhebung bestimmter Wörter.
  53.  
  54.  
  55. Installierung
  56. -------------
  57. IdeaForm  benötigt  eine Schlüsseldatei, die nach der Standard-Extension der
  58. entsprechenden  Programmiersprache  benannt  ist, also etwa BAS.KEY, PAS.KEY
  59. oder  MOD.KEY;  oder  einfach  eine  Schlüsseldatei namens IDEAFORM.KEY. Die
  60. Schlüsseldatei mu₧ entweder auf der gleichen Ordner-Ebene oder im Ordner KEY
  61. zu finden sein. Fermer mu₧ die Resourcedatei IDEAFORM.RSC vorhanden sein.
  62.  
  63.  
  64. Bedienung
  65. ---------
  66. Beim  Programmstart kann IdeaForm eine Textdatei übergeben werden. Ansonsten
  67. können  Sie  die  zu  formatierende Datei über den Button <Textdatei> in der
  68. darauf  erscheinenden  Fileselectbox  auswählen. IdeaForm versucht nun, eine
  69. dem  Quelltext  entsprechende  Schlüsseldatei  zu  finden. Für den Quelltext
  70. CRAY_EMU.C  sucht  IdeaForm  also  nach  der  Schlüsseldatei C.KEY. Nach dem
  71. Einstellen  der Quelldatei kann mit dem Button <KEY-Datei> nachträglich eine
  72. andere   Schlüsseldatei  gewählt  werden.  In  der  Infozeile  des  Fensters
  73. erscheint eine Information über die gewählte KEY-Datei.
  74.  
  75. Die Ausgabedatei kann auf dem System-Clipboard oder im Ordner der Quelldatei
  76. angelegt  werden.  Im  ersten  Fall wird SCRAP.TXT erzeugt, im zweiten nimmt
  77. IdeaForm  dazu  den Namen der Quelldatei, hängt aber die Extension TXA (Text
  78. mit Attributen) an. Die umformatierte Datei D:\QUELLE\CRAY_EMU.C landet also
  79. in D:\QUELLE\CRAY_EMU.TXA.
  80.  
  81. Mit  <Start>  beginnt  die  Formatierung.  IdeaForm  lädt die Quelldatei und
  82. öffnet eine Ausgabedatei. Der wachsende Balken zeigt, wie weit die Formatie-
  83. rung  fortgeschritten  ist.  IdeaForm  arbeitet  im  Hintergrund. Sie können
  84. währenddessen  also mit Accessories oder (in einer Multitaskingumgebung) mit
  85. anderen Programmen weiterarbeiten.
  86.  
  87. Achtung:  Als  Quelldatei  darf  nur ein reiner ASCII-Text verwendet werden,
  88. keinesfalls tokenisierte Dateien (*.BAS, *.GFA, *.ASM etc).
  89.  
  90. Die  Attributcodes,  die  in  der  Ausgabedatei eingefügt werden, sind keine
  91. Steuercodes, die ein Drucker versteht, sondern druckerunabhängige Markierun-
  92. gen.  Daher  sollte  die  Ausgabedatei  stets  über  IdeaList  oder Wordplus
  93. ausgedruckt  werden,  und nicht etwa direkt vom Desktop aus oder mit anderen
  94. Textverarbeitungen und Druckprogrammen ausgegeben werden.
  95.  
  96.  
  97. Aufruf aus IdeaList
  98. -------------------
  99. Von  IdeaList  aus  kann  IdeaForm  einfach  über einen Menüeintrag oder die
  100. entsprechende  Taste aufgerufen werden. IdeaForm startet dann sofort mit der
  101. Ausgabe auf das Clipboard und beendet sich danach von selbst.
  102.  
  103.  
  104. Schlüsseldatei
  105. --------------
  106. Die  Schlüsseldatei  dient  zur  Anpassung des Programms an die Programmier-
  107. sprache  der  Quelldatei.  Als  Beispiel  finden  Sie  im Ordner KEY mehrere
  108. Beispiele  für  solche  Dateien. Diese müssen Sie bei Bedarf auf die Ordner-
  109. Ebene von IdeaForm kopieren oder verschieben und in IDEAFORM.KEY umbenennen.
  110. Die Beispiele sind keinesfalls als vollständig zu betrachten. Über selbster-
  111. stellte oder erweiterte Schlüsseldateien freut sich der Autor immer.
  112.  
  113. Das Format der Schlüsseldateien ist ganz einfach:
  114.  
  115. Kommentare werden durch "+" gekennzeichnet. Relevante Eintragungen müssen am
  116. Zeilenanfang beginnen.
  117.  
  118. -  Die  erste Eintragung TITEL DER DATEI wird von IdeaForm als Kennung ange-
  119.  zeigt.
  120.  
  121. - Die  ATTRIBUTE  FÜR  SCHLÜSSELWÖRTER  und  ATTRIBUTE FÜR KOMMENTARE werden
  122.  jeweils  durch  eine "1" gesetzt. Jedes andere Zeichen (am besten eine "0")
  123.  schaltet das entsprechende Attribut ab. Mehrere Attribute dürfen kombiniert
  124.  werden.  Wenn  überhaupt  keine  Attribute  vereinbart  sind, werden in die
  125.  Ausgabedatei  auch keine Attributcodes geschrieben. Somit kann man IdeaForm
  126.  auch  verwenden,  um einfach nur eine einheitliche Schreibweise der Schlüs-
  127.  selwörter (etwa in Gro₧buchstaben) zu erhalten.
  128.  
  129. - Die  STRING-MARKIERUNGEN  bewirken,  da₧  Textteile  zwischen zwei solchen
  130.  Zeichen   nicht  als  formatierbar  betrachtet werden, sondern immer wie im
  131.  Quelltext  belassen  werden.  Es  sind zwei verschiedene Markierungszeichen
  132.  möglich,   die  direkt  hintereinander  angegeben werden müssen (z.B '" für
  133.  'String' und  "String").
  134.  
  135. - IdeaForm  unterscheidet zwei verschiedene KOMMENTARKLAMMERUNGEN. Falls die
  136.  Programmiersprache  nur  eine  Kommentar-Art kennt, mu₧ das zweite Klammer-
  137.  paar  als  Leerzeichen definiert werden. Falls der Kommentar automatisch am
  138.  Zeilenende  endet  (Basic  oder  Assembler...), ist als Kommentarende `EOL'
  139.  (End Of Line) anzugeben.
  140.  
  141. - Maximal  255  SCHLÜSSELWÖRTER  können  definiert werden; weniger sind auch
  142.  erlaubt,  überzählige werden ignoriert. Die Reihenfolge ist egal. Falls ein
  143.  Wort  länger  als  40  Zeichen ist, wird der Rest nicht beachtet. Als Buch-
  144.  staben  sind "a" bis "z" und "A" bis "Z" sowie, falls nicht an erster Stel-
  145.  le,"0"  bis  "9" und der Unterstrich "_" erlaubt. Gro₧- und Kleinschreibung
  146.  im Quelltext ist egal, in der Ausgabe werden die Wörter so geschrieben, wie
  147.  sie in der Schlüsseldatei definiert sind.
  148.  
  149.  
  150. Changes
  151. -------
  152. V1.30: GEM-Oberfläche (bisher: TTP)
  153. V1.26: Wenn keine Attribute vereinbart, werden keine Esc-Sequenzen geschrie-
  154.        ben.
  155. V1.25: Automatische  Suche nach der zur Programmiersprache passenden Schlüs-
  156.        seldatei
  157. V1.24: Zwei verschiedene Stringmarkierungen (statt bisher eine)
  158. V1.23: Maximal 255 Schlüsselworte (statt bisher 50)
  159. V1.22: Bugfixes: Zugriffspfad, Kommentarklammerungen
  160. V1.10: Erste veröffentlichte TTP-Version
  161.  
  162.  
  163. ------------------------- Ende von IDEAFORM.TXT ----------------------------